From 5a9847b87c87eaab9412cf4e4b8e0799ebbffb04 Mon Sep 17 00:00:00 2001
From: tsteven4 <13596209+tsteven4@users.noreply.github.com>
Date: Wed, 3 Aug 2022 07:54:29 -0600
Subject: [PATCH] convert html writer to textstream. (#904)

---
 html.cc                                       | 153 +++++++++---------
 html.h                                        |  12 +-
 reference/gc/GC7FA4.html                      |   6 +-
 ...A8~text-encoded.txt => GCGCA8-encoded.txt} |   0
 reference/gc/{GCGCA8~html.txt => GCGCA8.html} |   6 +-
 reference/gc/{GCGCA8~text.txt => GCGCA8.txt}  |   0
 ...{GCGCA8_logs~html.txt => GCGCA8_logs.html} |   6 +-
 testo.d/text.test                             |   8 +-
 8 files changed, 103 insertions(+), 88 deletions(-)
 rename reference/gc/{GCGCA8~text-encoded.txt => GCGCA8-encoded.txt} (100%)
 rename reference/gc/{GCGCA8~html.txt => GCGCA8.html} (98%)
 rename reference/gc/{GCGCA8~text.txt => GCGCA8.txt} (100%)
 rename reference/gc/{GCGCA8_logs~html.txt => GCGCA8_logs.html} (99%)

diff --git a/html.cc b/html.cc
index 254009524..4619040ad 100644
--- a/html.cc
+++ b/html.cc
@@ -21,17 +21,20 @@
 
 #include "html.h"
 
+#include <QChar>                   // for QChar
+#include <QIODevice>               // for QIODevice, QIODevice::WriteOnly
 #include <QString>                 // for QString, operator!=
+#include <QTextStream>             // for QTextStream
 #include <Qt>                      // for CaseInsensitive
 
 #include <cstdint>                 // for int32_t
-#include <ctime>                   // for localtime, time_t, tm
+#include <ctime>                   // for localtime, time_t
 
-#include "defs.h"                  // for Waypoint, xfree, geocache_data, html_entitize, CSTR, pretty_deg_format, rot13, strip_nastyhtml, waypt_disp_all, utf_string, METERS_TO_FEET, gpsbabel_testmode, gs_get_cachetype, gs_get_container, mkshort_del_handle, mkshort_from_wpt, mkshort_new_handle
+#include "defs.h"
 #include "formspec.h"              // for FormatSpecificDataList, kFsGpx
-#include "gbfile.h"                // for gbfprintf, gbfclose, gbfopen, gbfputs
 #include "jeeps/gpsmath.h"         // for GPS_Math_WGS84_To_UTM_EN
 #include "src/core/datetime.h"     // for DateTime
+#include "src/core/textstream.h"   // for TextStream
 #include "src/core/xmltag.h"       // for xml_findfirst, xml_tag, xml_attribute, fs_xml, xml_findnext
 
 
@@ -40,14 +43,17 @@
 void
 HtmlFormat::wr_init(const QString& fname)
 {
-  file_out = gbfopen(fname, "w", MYNAME);
+  file_out = new gpsbabel::TextStream;
+  file_out->open(fname, QIODevice::WriteOnly, MYNAME);
   mkshort_handle = mkshort_new_handle();
 }
 
 void
 HtmlFormat::wr_deinit()
 {
-  gbfclose(file_out);
+  file_out->close();
+  delete file_out;
+  file_out = nullptr;
   mkshort_del_handle(&mkshort_handle);
 }
 
@@ -63,53 +69,55 @@ HtmlFormat::html_disp(const Waypoint* wpt) const
   GPS_Math_WGS84_To_UTM_EN(wpt->latitude, wpt->longitude,
                            &utme, &utmn, &utmz, &utmzc);
 
-  gbfprintf(file_out, "\n<a name=\"%s\"><hr></a>\n", CSTR(wpt->shortname));
-  gbfprintf(file_out, "<table width=\"100%%\">\n");
-  gbfprintf(file_out, "<tr><td><p class=\"gpsbabelwaypoint\">%s - ",(global_opts.synthesize_shortnames) ? CSTR(mkshort_from_wpt(mkshort_handle, wpt)) : CSTR(wpt->shortname));
-  gbfprintf(file_out, "%s (%d%c %6.0f %7.0f)",
-            CSTR(pretty_deg_format(wpt->latitude, wpt->longitude, degformat[2], " ", true)),
-            utmz, utmzc, utme, utmn);
+  *file_out << "\n<a name=\"" << wpt->shortname << "\"><hr></a>\n";
+  *file_out << "<table width=\"100%\">\n";
+  QString sn = global_opts.synthesize_shortnames ? mkshort_from_wpt(mkshort_handle, wpt) : wpt->shortname;
+  *file_out << "<tr><td><p class=\"gpsbabelwaypoint\">" << sn << " - ";
+  *file_out << QStringLiteral("%1 (%2%3 %4 %5)")
+            .arg(pretty_deg_format(wpt->latitude, wpt->longitude, degformat[2], " ", true))
+            .arg(utmz)
+            .arg(utmzc)
+            .arg(utme, 6, 'f', 0)
+            .arg(utmn, 7, 'f', 0);
   if (wpt->altitude != unknown_alt) {
-    gbfprintf(file_out, " alt:%d", (int)((altunits[0]=='f')?METERS_TO_FEET(wpt->altitude):wpt->altitude));
+    *file_out << QStringLiteral(" alt:%1")
+              .arg((int)((altunits[0]=='f') ? METERS_TO_FEET(wpt->altitude) : wpt->altitude));
   }
-  gbfprintf(file_out, "<br>\n");
+  *file_out << "<br>\n";
   if (wpt->description != wpt->shortname) {
     if (wpt->HasUrlLink()) {
-      gbfputs(QStringLiteral("<a href=\"%1\">%2</a>")
-              .arg(wpt->GetUrlLink().url_, html_entitize(wpt->description)),
-              file_out);
+      *file_out << "<a href=\"" << wpt->GetUrlLink().url_ << "\">"
+                << html_entitize(wpt->description) << "</a>";
     } else {
-      gbfprintf(file_out, "%s", CSTR(wpt->description));
+      *file_out << wpt->description;
     }
     if (!wpt->gc_data->placer.isEmpty()) {
-      gbfprintf(file_out, " by %s", CSTR(wpt->gc_data->placer));
+      *file_out << " by " << wpt->gc_data->placer;
     }
   }
-  gbfprintf(file_out, "</p></td>\n");
+  *file_out << "</p></td>\n";
 
-  gbfprintf(file_out, "<td align=\"right\">");
+  *file_out << "<td align=\"right\">";
   if (wpt->gc_data->terr) {
-    gbfprintf(file_out, "<p class=\"gpsbabelcacheinfo\">%d%s / %d%s<br>\n",
-              (int)(wpt->gc_data->diff / 10), (wpt->gc_data->diff%10) ? "&frac12;" : "",
-              (int)(wpt->gc_data->terr / 10), (wpt->gc_data->terr%10) ? "&frac12;" : "");
-    gbfputs(QStringLiteral("%1 / %2</p>")
-            .arg(gs_get_cachetype(wpt->gc_data->type),
-                 gs_get_container(wpt->gc_data->container)),
-            file_out);
+    *file_out << QStringLiteral("<p class=\"gpsbabelcacheinfo\">%1%2 / %3%4<br>\n")
+              .arg((int)(wpt->gc_data->diff / 10))
+              .arg((wpt->gc_data->diff%10) ? "&frac12;" : "")
+              .arg((int)(wpt->gc_data->terr / 10))
+              .arg((wpt->gc_data->terr%10) ? "&frac12;" : "");
+    *file_out << gs_get_cachetype(wpt->gc_data->type) << " / "
+              << gs_get_container(wpt->gc_data->container) << "</p>";
   }
-  gbfprintf(file_out, "</td></tr>\n");
+  *file_out << "</td></tr>\n";
 
 
-  gbfprintf(file_out, "<tr><td colspan=\"2\">");
+  *file_out << "<tr><td colspan=\"2\">";
   if (!wpt->gc_data->desc_short.utfstring.isEmpty()) {
-    gbfputs(QStringLiteral("<p class=\"gpsbabeldescshort\">%1</p>\n")
-            .arg(strip_nastyhtml(wpt->gc_data->desc_short.utfstring)),
-            file_out);
+    *file_out << "<p class=\"gpsbabeldescshort\">"
+              << strip_nastyhtml(wpt->gc_data->desc_short.utfstring) << "</p>\n";
   }
   if (!wpt->gc_data->desc_long.utfstring.isEmpty()) {
-    gbfputs(QStringLiteral("<p class=\"gpsbabeldesclong\">%1</p>\n")
-            .arg(strip_nastyhtml(wpt->gc_data->desc_long.utfstring)),
-            file_out);
+    *file_out << "<p class=\"gpsbabeldesclong\">"
+              << strip_nastyhtml(wpt->gc_data->desc_long.utfstring) << "</p>\n";
   }
   if (!wpt->gc_data->hint.isEmpty()) {
     QString hint;
@@ -118,9 +126,10 @@ HtmlFormat::html_disp(const Waypoint* wpt) const
     } else {
       hint = wpt->gc_data->hint;
     }
-    gbfprintf(file_out, "<p class=\"gpsbabelhint\"><strong>Hint:</strong> %s</p>\n", CSTR(hint));
+    *file_out << "<p class=\"gpsbabelhint\"><strong>Hint:</strong> "
+              << hint << "</p>\n";
   } else if (!wpt->notes.isEmpty() && (wpt->description.isEmpty() || wpt->notes != wpt->description)) {
-    gbfprintf(file_out, "<p class=\"gpsbabelnotes\">%s</p>\n", CSTR(wpt->notes));
+    *file_out << "<p class=\"gpsbabelnotes\">" << wpt->notes << "</p>\n";
   }
 
   if (includelogs) {
@@ -130,18 +139,18 @@ HtmlFormat::html_disp(const Waypoint* wpt) const
       xml_tag* curlog = xml_findfirst(root, "groundspeak:log");
       while (curlog) {
         time_t logtime = 0;
-        gbfprintf(file_out, "<p class=\"gpsbabellog\">\n");
+        *file_out << "<p class=\"gpsbabellog\">\n";
 
         xml_tag* logpart = xml_findfirst(curlog, "groundspeak:type");
         if (logpart) {
-          gbfprintf(file_out, "<span class=\"gpsbabellogtype\">%s</span> by ", CSTR(logpart->cdata));
+          *file_out << "<span class=\"gpsbabellogtype\">"
+                    << logpart->cdata << "</span> by ";
         }
 
         logpart = xml_findfirst(curlog, "groundspeak:finder");
         if (logpart) {
-          gbfputs(QStringLiteral("<span class=\"gpsbabellogfinder\">%1</span> on ")
-                  .arg(html_entitize(logpart->cdata)),
-                  file_out);
+          *file_out << "<span class=\"gpsbabellogfinder\">"
+                    << html_entitize(logpart->cdata) << "</span> on ";
         }
 
         logpart = xml_findfirst(curlog, "groundspeak:date");
@@ -149,11 +158,10 @@ HtmlFormat::html_disp(const Waypoint* wpt) const
           logtime = xml_parse_time(logpart->cdata).toTime_t();
           struct tm* logtm = localtime(&logtime);
           if (logtm) {
-            gbfprintf(file_out,
-                      "<span class=\"gpsbabellogdate\">%04d-%02d-%02d</span><br>\n",
-                      logtm->tm_year+1900,
-                      logtm->tm_mon+1,
-                      logtm->tm_mday);
+            *file_out << QStringLiteral("<span class=\"gpsbabellogdate\">%1-%2-%3</span><br>\n")
+                      .arg(logtm->tm_year+1900, 4, 10, QChar('0'))
+                      .arg(logtm->tm_mon+1, 2, 10, QChar('0'))
+                      .arg(logtm->tm_mday, 2, 10, QChar('0'));
           }
         }
 
@@ -161,9 +169,8 @@ HtmlFormat::html_disp(const Waypoint* wpt) const
         if (logpart) {
           double lat = xml_attribute(logpart->attributes, "lat").toDouble();
           double lon = xml_attribute(logpart->attributes, "lon").toDouble();
-          gbfprintf(file_out,
-                    "<span class=\"gpsbabellogcoords\">%s</span><br>\n",
-                    CSTR(pretty_deg_format(lat, lon, degformat[2], " ", true)));
+          *file_out << "<span class=\"gpsbabellogcoords\">"
+                    << pretty_deg_format(lat, lon, degformat[2], " ", true) << "</span><br>\n";
         }
 
         logpart = xml_findfirst(curlog, "groundspeak:text");
@@ -178,23 +185,23 @@ HtmlFormat::html_disp(const Waypoint* wpt) const
             s = logpart->cdata;
           }
 
-          gbfputs(html_entitize(s), file_out);
+          *file_out << html_entitize(s);
         }
 
-        gbfprintf(file_out, "</p>\n");
+        *file_out << "</p>\n";
         curlog = xml_findnext(root, curlog, "groundspeak:log");
       }
     }
   }
-  gbfprintf(file_out, "</td></tr></table>\n");
+  *file_out << "</td></tr>\n";
+  *file_out << "</table>\n";
 }
 
 void
 HtmlFormat::html_index(const Waypoint* wpt) const
 {
-  gbfputs(QStringLiteral("<a href=\"#%1\">%1 - %2</a><br>\n")
-          .arg(html_entitize(wpt->shortname), html_entitize(wpt->description)),
-          file_out);
+  *file_out << QStringLiteral("<a href=\"#%1\">%1 - %2</a><br>\n")
+            .arg(html_entitize(wpt->shortname), html_entitize(wpt->description));
 }
 
 void
@@ -202,42 +209,44 @@ HtmlFormat::write()
 {
   setshort_length(mkshort_handle, 6);
 
-  gbfprintf(file_out, "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\n");
-  gbfprintf(file_out, "<html>\n");
-  gbfprintf(file_out, "<head>\n");
-  gbfprintf(file_out, " <meta http-equiv=\"Content-Type\" content=\"text/html;charset=utf-8\">\n");
+  *file_out << "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\n";
+  *file_out << "<html>\n";
+  *file_out << "<head>\n";
+  *file_out << " <meta http-equiv=\"Content-Type\" content=\"text/html;charset=utf-8\">\n";
 
   // Don't write this line when running test suite.  Actually, we should
   // probably not write this line at all...
   if (!gpsbabel_testmode()) {
-    gbfprintf(file_out, " <meta name=\"Generator\" content=\"GPSBabel %s\">\n", gpsbabel_version);
+    *file_out << " <meta name=\"Generator\" content=\"GPSBabel "
+              << gpsbabel_version << "\">\n";
   }
-  gbfprintf(file_out, " <title>GPSBabel HTML Output</title>\n");
+  *file_out << " <title>GPSBabel HTML Output</title>\n";
   if (stylesheet) {
-    gbfprintf(file_out, " <link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">\n", stylesheet);
+    *file_out << " <link rel=\"stylesheet\" type=\"text/css\" href=\""
+              << stylesheet << "\">\n";
   } else {
-    gbfprintf(file_out, " <style>\n");
-    gbfprintf(file_out, "  p.gpsbabelwaypoint { font-size: 120%%; font-weight: bold }\n");
-    gbfprintf(file_out, " </style>\n");
+    *file_out << " <style>\n";
+    *file_out << "  p.gpsbabelwaypoint { font-size: 120%; font-weight: bold }\n";
+    *file_out << " </style>\n";
   }
-  gbfprintf(file_out, "</head>\n");
-  gbfprintf(file_out, "<body>\n");
+  *file_out << "</head>\n";
+  *file_out << "<body>\n";
 
-  gbfprintf(file_out, "<p class=\"index\">\n");
+  *file_out << "<p class=\"index\">\n";
 
   auto html_index_lambda = [this](const Waypoint* waypointp)->void {
     html_index(waypointp);
   };
 
   waypt_disp_all(html_index_lambda);
-  gbfprintf(file_out, "</p>\n");
+  *file_out << "</p>\n";
 
   auto html_disp_lambda = [this](const Waypoint* waypointp)->void {
     html_disp(waypointp);
   };
   waypt_disp_all(html_disp_lambda);
 
-  gbfprintf(file_out, "</body>");
-  gbfprintf(file_out, "</html>");
+  *file_out << "</body>\n";
+  *file_out << "</html>\n";
 
 }
diff --git a/html.h b/html.h
index 0c74dca65..d80623241 100644
--- a/html.h
+++ b/html.h
@@ -21,12 +21,12 @@
 #ifndef HTML_H_INCLUDED_
 #define HTML_H_INCLUDED_
 
-#include <QString>   // for QString
-#include <QVector>   // for QVector
+#include <QString>                // for QString
+#include <QVector>                // for QVector
 
-#include "defs.h"    // for arglist_t, ff_cap, ARG_NOMINMAX, ARGTYPE_STRING, ARGTYPE_BOOL, Waypoint, ff_cap_none, CET_CHARSET_UTF8, ff_cap_write, ff_type, ff_type_file, short_handle
-#include "format.h"  // for Format
-#include "gbfile.h"  // for gbfile
+#include "defs.h"
+#include "format.h"               // for Format
+#include "src/core/textstream.h"  // for TextStream
 
 
 class HtmlFormat : public Format
@@ -70,7 +70,7 @@ private:
 
   /* Data Members */
 
-  gbfile* file_out{};
+  gpsbabel::TextStream* file_out{nullptr};
   short_handle mkshort_handle{};
 
   char* stylesheet = nullptr;
diff --git a/reference/gc/GC7FA4.html b/reference/gc/GC7FA4.html
index 7c3987d03..bf2d18466 100644
--- a/reference/gc/GC7FA4.html
+++ b/reference/gc/GC7FA4.html
@@ -110,5 +110,7 @@ Point Geodesique situe near Port de Plaisance de Longueuil
 sur le bord du fleuve st-laurent.
 Il y a des sentiers et une grande piste cyclable
 Enjoy !</p>
-</td></tr></table>
-</body></html>
\ No newline at end of file
+</td></tr>
+</table>
+</body>
+</html>
diff --git a/reference/gc/GCGCA8~text-encoded.txt b/reference/gc/GCGCA8-encoded.txt
similarity index 100%
rename from reference/gc/GCGCA8~text-encoded.txt
rename to reference/gc/GCGCA8-encoded.txt
diff --git a/reference/gc/GCGCA8~html.txt b/reference/gc/GCGCA8.html
similarity index 98%
rename from reference/gc/GCGCA8~html.txt
rename to reference/gc/GCGCA8.html
index 239c450d0..8f7bcadbc 100644
--- a/reference/gc/GCGCA8~html.txt
+++ b/reference/gc/GCGCA8.html
@@ -36,5 +36,7 @@ Now that it's intuitively obvious to even the most casual observer where the cac
 <br>
 <img SRC="http://www.mtgc.org/mtgc_member-banner.gif" WIDTH="500" HEIGHT="40" ALT="Member of Middle Tennessee GeoCachers Club [www.mtgc.org]" BORDER="0"></a></p></p>
 <p class="gpsbabelhint"><strong>Hint:</strong> There Is No Hint</p>
-</td></tr></table>
-</body></html>
+</td></tr>
+</table>
+</body>
+</html>
diff --git a/reference/gc/GCGCA8~text.txt b/reference/gc/GCGCA8.txt
similarity index 100%
rename from reference/gc/GCGCA8~text.txt
rename to reference/gc/GCGCA8.txt
diff --git a/reference/gc/GCGCA8_logs~html.txt b/reference/gc/GCGCA8_logs.html
similarity index 99%
rename from reference/gc/GCGCA8_logs~html.txt
rename to reference/gc/GCGCA8_logs.html
index e5bac5a79..5f75d6975 100644
--- a/reference/gc/GCGCA8_logs~html.txt
+++ b/reference/gc/GCGCA8_logs.html
@@ -60,5 +60,7 @@ In the expectation that this cache will get some traffic in the next 48 hours, R
 <p class="gpsbabellog">
 <span class="gpsbabellogtype">Write note</span> by <span class="gpsbabellogfinder">robertlipe</span> on <span class="gpsbabellogdate">2003-07-03</span><br>
 It won't earn him a smiley face, but I've confirmed that rickrich would have indeed sunk the battleship!      Thanx for playing. You get a copy of the home game and some rice-a-roni...</p>
-</td></tr></table>
-</body></html>
\ No newline at end of file
+</td></tr>
+</table>
+</body>
+</html>
diff --git a/testo.d/text.test b/testo.d/text.test
index b60fb4ea4..e89b52226 100644
--- a/testo.d/text.test
+++ b/testo.d/text.test
@@ -4,12 +4,12 @@ gpsbabel -i gpx -f ${REFERENCE}/gc/GCGCA8.gpx \
   -o html -F ${TMPDIR}/gc.html \
   -o text -F ${TMPDIR}/gc.txt \
   -o text,encrypt -F ${TMPDIR}/gc-encoded.txt
-compare ${REFERENCE}/gc/GCGCA8~text.txt ${TMPDIR}/gc.txt
-compare ${REFERENCE}/gc/GCGCA8~text-encoded.txt ${TMPDIR}/gc-encoded.txt
-compare ${REFERENCE}/gc/GCGCA8~html.txt ${TMPDIR}/gc.html
+compare ${REFERENCE}/gc/GCGCA8.txt ${TMPDIR}/gc.txt
+compare ${REFERENCE}/gc/GCGCA8-encoded.txt ${TMPDIR}/gc-encoded.txt
+compare ${REFERENCE}/gc/GCGCA8.html ${TMPDIR}/gc.html
 
 gpsbabel -i gpx -f ${REFERENCE}/gc/GCGCA8.gpx -o html,logs -F ${TMPDIR}/gc_logs.html
-compare ${REFERENCE}/gc/GCGCA8_logs~html.txt ${TMPDIR}/gc_logs.html
+compare ${REFERENCE}/gc/GCGCA8_logs.html ${TMPDIR}/gc_logs.html
 
 gpsbabel -i gpx -f ${REFERENCE}/gc/GC7FA4.gpx \
   -o html,logs -F ${TMPDIR}/GC7FA4.html \
-- 
2.30.2